home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 22 / Cream of the Crop 22.iso / editor / jmedia20.zip / COMMANDS.DOC < prev    next >
Text File  |  1996-11-01  |  45KB  |  1,296 lines

  1. This is a list of all the available commands JMedia can use. Commands
  2. marked as EXTENDED cannot be used for creating RIP menus for BBSes.
  3. Internal, Macro, and all the other NON extended commands can be used
  4. for both JMedia applications and RIP BBS menus.
  5.  
  6. Commands that contain x2 and y2 co-ordinates such as the Rectangle
  7. and Bar command can use a "+" in front of the x2 and y2 co-ordinate
  8. to indicate a width and height relative to the x,y co-ordinates.
  9.  
  10.  
  11.  
  12. ---------------------------------------------------------------------
  13. SetDimensions                                      (INTERNAL COMMAND)
  14. ---------------------------------------------------------------------
  15.     Function: Segments the screen into smaller dimensions
  16. Parameter(s): oldWidth oldHeight newWidth newHeight
  17.  
  18.      Example: 640 350 80 43
  19.  
  20.  
  21. The SetDimensions command effects most graphics commands that contain
  22. co-ordinates, it does not effect the TextWindow command. All graphic
  23. commands following the SetDimensions command will use the new values
  24. to calculate real co-ordinates. The command can be reset at any time
  25. throughout your JMedia scripts by specifying new dimensions. To reset
  26. the command for single pixel precision just type SetDimensions 1 1 1 1
  27.  
  28.  
  29.  
  30. ---------------------------------------------------------------------
  31. TextWindow
  32. ---------------------------------------------------------------------
  33.     Function: Creates a Text Window by specifying size and font to use
  34. Parameter(s):  x y x2 y2 wrap font
  35.  
  36.      Example: TextWindow 0 0 79 42 0 0
  37.               TextWindow 0 0 +80 +43 NO 0
  38.               TextWindow 0 0 +80 +43 YES 0
  39.  
  40.  
  41.               Font   Font Size   X Range  Y Range
  42.              ------------------------------------------
  43.                0     8x8         *0-79    *0-42
  44.                1     7x8         *0-90    *0-42
  45.                2     8x14        *0-79    *0-24
  46.                3     7x14        *0-90    *0-24
  47.                4     16x14       *0-39    *0-24
  48.  
  49.  
  50. The wrap parameter is used if you want text that exceeds the width
  51. of the text window to continue on into the next line instead of being
  52. truncated.
  53.  
  54. (*) Max range can be up to 255 rows/columns, the numbers listed are the
  55.     max used when creating BBS RIP screens.
  56.  
  57.  
  58. ---------------------------------------------------------------------
  59. ViewPort
  60. ---------------------------------------------------------------------
  61.     Function:  Defines the graphics window
  62. Parameter(s):  x y x2 y2
  63.  
  64.      Example: ViewPort 0 0 649 199
  65.               ViewPort 0 0 +650 +200
  66.  
  67.  
  68.  
  69. ---------------------------------------------------------------------
  70. ResetWindows
  71. ---------------------------------------------------------------------
  72.     Function: Clears both the Graphics and Text Windows by resetting
  73.               them to full screen
  74. Parameter(s): none
  75.  
  76.      Example: ResetWindows
  77.  
  78.  
  79.  
  80. ---------------------------------------------------------------------
  81. EraseWindow
  82. ---------------------------------------------------------------------
  83.     Function: Clears the text window
  84. Parameter(s): none
  85.  
  86.      Example: EraseWindow
  87.  
  88.  
  89. ---------------------------------------------------------------------
  90. EraseView
  91. ---------------------------------------------------------------------
  92.     Function: Clears the graphics window
  93. Parameter(s): none
  94.  
  95.      Example: EraseView
  96.  
  97.  
  98. ---------------------------------------------------------------------
  99. GotoXY
  100. ---------------------------------------------------------------------
  101.     Function:  Moves the text cursor to x,y co-ordinates within the
  102.                text window area row & column in Text Window
  103. Parameter(s): x y
  104.  
  105.      Example: GotoXY 0 0
  106.               GotoXY 79 42
  107.  
  108.  
  109. ---------------------------------------------------------------------
  110. Home
  111. ---------------------------------------------------------------------
  112.     Function: Moves text cursor to 0,0 co-ordinates within the
  113.               text window
  114. Parameter(s): none
  115.  
  116.      Example: Home
  117.  
  118.  
  119. ---------------------------------------------------------------------
  120. EraseEOL
  121. ---------------------------------------------------------------------
  122.     Function: Erase the current line from cursor position to the end
  123.               of the line
  124. Parameter(s): none
  125.  
  126.      Example: EraseEOL
  127.  
  128.  
  129.  
  130. ---------------------------------------------------------------------
  131. Color
  132. ---------------------------------------------------------------------
  133.     Function: Sets the drawing color for some of graphics commands
  134. Parameter(s): Color
  135.  
  136.      Example: Color 1
  137.               Color Blue
  138.  
  139.  
  140.  
  141.      Value   Color
  142.      --------------------------
  143.       0      Black
  144.       1      Blue
  145.       2      Green
  146.       3      Cyan
  147.       4      Red
  148.       5      Magenta
  149.       6      Brown
  150.       7      LightGray
  151.       8      DarkGray
  152.       9      LightBlue
  153.      10      LightGreen
  154.      11      LightCyan
  155.      12      LightRed
  156.      13      LightMagenta
  157.      14      Yellow
  158.      15      White
  159.  
  160. NOTE: Some graphic commands are not effected by the color function, you
  161.       must use the SetFillStyle or SetFillPattern functions.
  162.  
  163.  
  164. ---------------------------------------------------------------------
  165. SetPalette
  166. ---------------------------------------------------------------------
  167.     Function: Sets a new the 16 color palette. Each color value must
  168.               range from 0 to 63.
  169.  
  170. Parameter(s): v1 v2 v3 v4 v5 v6 v7 v8 v9 v10 v11 v12 v13 v14 v15 v16
  171.  
  172.      Example: SetPalette 4 6 0 2 54 44 21 3 7 9 12 60 61 31 33 45
  173.  
  174.  
  175.  
  176. ---------------------------------------------------------------------
  177. OnePalette
  178. ---------------------------------------------------------------------
  179.     Function: Sets one color of the 16 color palette
  180. Parameter(s): ColorNumber Value
  181.  
  182.      Example: OnePalette 0 44
  183.  
  184.  
  185. ---------------------------------------------------------------------
  186. WriteMode
  187. ---------------------------------------------------------------------
  188.     Function: Sets the drawing mode for some of the graphic commands
  189. Parameter(s): Mode
  190.  
  191.      Example: WriteMode 0
  192.               WriteMode 1
  193.               WriteMode CopyPut
  194.               WriteMode XorPut
  195.  
  196.  
  197. ---------------------------------------------------------------------
  198. Move
  199. ---------------------------------------------------------------------
  200.     Function: Moves the graphics pen position to a new location
  201. Parameter(s): x y
  202.  
  203.      Example: Move 10 50
  204.  
  205.  
  206. ---------------------------------------------------------------------
  207. Text
  208. ---------------------------------------------------------------------
  209.     Function: Print text in the graphics window using the current
  210.               font and color at the current pen position
  211. Parameter(s): TextString
  212.  
  213.      Example: Text Hello
  214.  
  215.  
  216. ---------------------------------------------------------------------
  217. TextXY
  218. ---------------------------------------------------------------------
  219.     Function: print text in the graphics window at x,y co-ordinates
  220. Parameter(s): x y TextString
  221.  
  222.      Example: TextXY 100 100 Hello Everybody
  223.  
  224.  
  225. ---------------------------------------------------------------------
  226. FontStyle
  227. ---------------------------------------------------------------------
  228.     Function: Sets current graphics font style, orientation and size.
  229. Parameter(s): font direction size
  230.  
  231.      Example: FontStyle 1 0 5
  232.               FontStyle Triplex HorizDir 5
  233.               FontStyle Triplex VertDir 5
  234.  
  235.  
  236.      Font  FontName
  237.      -----------------
  238.      0     Default
  239.      1     Triplex
  240.      2     Small
  241.      3     SansSerif
  242.      4     Gothic
  243.      5     Script
  244.      6     Simplex
  245.      7     Triplex
  246.      8     Complex
  247.      9     European
  248.      10    Bold
  249.  
  250. For the Size parameter use values 1 to 10
  251.  
  252.  
  253. ---------------------------------------------------------------------
  254. Pixel
  255. ---------------------------------------------------------------------
  256.      Function: Plots a pixel at the specified x,y co-ordinates
  257.                using the current color
  258. Parameter(s): x y
  259.  
  260.      Example: Pixel 50 50
  261.  
  262.  
  263. ---------------------------------------------------------------------
  264. Line
  265. ---------------------------------------------------------------------
  266.     Function: Plots a line using the current color and line style
  267. Parameter(s): x y x2 y2
  268.  
  269.      Example: Line 50 50 100 100
  270.               Line 50 50 +50 +50
  271.  
  272.  
  273. ---------------------------------------------------------------------
  274. Rectangle
  275. ---------------------------------------------------------------------
  276.     Function:  Plots a rectangle using the current color line style
  277. Parameter(s): x y x2 y2
  278.  
  279.      Example: Rectangle 50 50 100 100
  280.               Rectangle 50 50 +50 +50
  281.  
  282.  
  283. ---------------------------------------------------------------------
  284. Bar
  285. ---------------------------------------------------------------------
  286.     Function: Plots a filled rectangle using the current fill color
  287.               and pattern
  288. Parameter(s): x y x2 y2
  289.  
  290.      Example: Bar 50 50 100 100
  291.               Bar 50 50 +50 +50
  292.  
  293.  
  294. ---------------------------------------------------------------------
  295. Circle
  296. ---------------------------------------------------------------------
  297.     Function: Plots a circle using the current color and line
  298.               thickness
  299. Parameter(s): x y radius
  300.  
  301.      Example: Circle 100 100 50
  302.  
  303.  
  304.  
  305. ---------------------------------------------------------------------
  306. Oval
  307. ---------------------------------------------------------------------
  308.     Function: Plots an elliptical arc using the current color and
  309.               line style
  310. Parameter(s): x y StartAngle EndAngle xradius yradius
  311.  
  312.      Example: Oval 100 100 0 360 50 60
  313.  
  314.  
  315. ---------------------------------------------------------------------
  316. FilledOval
  317. ---------------------------------------------------------------------
  318.     Function: Plots a filled ellipse using the current color and
  319.               fill pattern
  320. Parameter(s): x y xradius yradius
  321.  
  322.      Example: FilledOval 100 100 50 60
  323.  
  324.  
  325. ---------------------------------------------------------------------
  326. Arc
  327. ---------------------------------------------------------------------
  328.     Function: Plots a circular arc using the current color and line
  329.               thickness
  330. Parameter(s): x y StartAngle EndAngle radius
  331.  
  332.      Example: Arc 100 100 90 180 50
  333.  
  334.  
  335. ---------------------------------------------------------------------
  336. OvalArc
  337. ---------------------------------------------------------------------
  338.     Function: Plots an elliptical arc
  339. Parameter(s): x y StartAngle EndAngle xradius yradius
  340.  
  341.      Example: OvalArc 100 100 90 180 50 60
  342.  
  343.  
  344. ---------------------------------------------------------------------
  345. PieSlice
  346. ---------------------------------------------------------------------
  347.     Function: Plots a circular pie slice
  348. Parameter(s): x y StartAngle EndAngle radius
  349.  
  350.      Example: PieSlice 100 100 90 180 50
  351.  
  352.  
  353. ---------------------------------------------------------------------
  354. OvalPieSlice
  355. ---------------------------------------------------------------------
  356.     Function: Plots an elliptical pie slice
  357. Parameter(s): x y StartAngle EndAngle xradius yradius
  358.  
  359.      Example: OvalPieSlice 100 100 90 180 50 60
  360.  
  361.  
  362. ---------------------------------------------------------------------
  363. Bezier
  364. ---------------------------------------------------------------------
  365.     Function: Plots a bezier curve using the current color and line
  366.               style
  367. Parameter(s): x y x2 y2 x3 y3 x4 y4 Segments
  368.  
  369.      Example: Bezier 392 136 388 133 380 135 378 141 10
  370.  
  371.  
  372. ---------------------------------------------------------------------
  373. Polygon
  374. ---------------------------------------------------------------------
  375.     Function: Plots a polygon using the current color and line style
  376. Parameter(s): x y x2 y2 ...
  377.  
  378.      Example: Polygon 10 10 20 10 30 40
  379.               Polygon 10 10 20 10 \
  380.                       30 40
  381.               Polygon 10 10 \
  382.                       20 10 \
  383.                       30 40
  384.  
  385. The backslash can be used at the end of the line to indicate that more x,y
  386. co-ordinates continue in the next line
  387.  
  388.  
  389. ---------------------------------------------------------------------
  390. FillPolygon
  391. ---------------------------------------------------------------------
  392.     Function: Plots a filled polygon using the current color and
  393.               fill pattern
  394. Parameter(s): x y x2 y2 ...
  395.  
  396.      Example: FillPolygon 10 10 20 10 30 40
  397.               FillPolygon 10 10 20 10 \
  398.                           30 40
  399.               FillPolygon 10 10 \
  400.                           20 10 \
  401.                           30 40
  402.  
  403. The backslash can be used at the end of the line to indicate that more x,y
  404. co-ordinates continue in the next line
  405.  
  406.  
  407. ---------------------------------------------------------------------
  408. Polyline
  409. ---------------------------------------------------------------------
  410.     Function: Plots a Polyline using the current color and line
  411.               style
  412. Parameter(s): x y x2 y2 ...
  413.  
  414.      Example: Polyline 10 10 20 10 30 40
  415.               Polyline 10 10 20 10 \
  416.                        30 40
  417.               Polyline 10 10 \
  418.                        20 10 \
  419.                        30 40
  420.  
  421. The backslash can be used at the end of the line to indicate that more x,y
  422. co-ordinates continue in the next line
  423.  
  424.  
  425. ---------------------------------------------------------------------
  426. Fill
  427. ---------------------------------------------------------------------
  428.     Function: Flood fills the screen area with current fill color
  429.               and pattern
  430. Parameter(s): x y BorderColor
  431.  
  432.      Example: Fill 10 10 15
  433.               Fill 10 10 White
  434.  
  435.  
  436. ---------------------------------------------------------------------
  437. LineStyle
  438. ---------------------------------------------------------------------
  439.     Function: Sets the line style and thickness
  440. Parameter(s): style userpattern thickness
  441.  
  442.      Example: LineStyle 0 0 1
  443.               LineStyle SolidLn 0 NormWidth
  444.               LineStyle DottedLn 0 ThickWidth
  445.  
  446.  
  447.      Style   Style Name
  448.      --------------------
  449.       0      SolidLn
  450.       1      DottedLn
  451.       2      CenterLn
  452.       3      DashedLn
  453.       4      CustomLn
  454.  
  455.      Thick   Thickness Name
  456.      ---------------------
  457.       1      NormWidth
  458.       3      ThickWidth
  459.  
  460.  
  461. If the style is set to a value of 4 (CustomLn) then the userpattern
  462. must contain a 16 bit pattern otherwise it should be set to 0.
  463.  
  464.  
  465. ---------------------------------------------------------------------
  466. FillStyle
  467. ---------------------------------------------------------------------
  468.     Function: Sets the current fill style & fill color
  469. Parameter(s): style color
  470.  
  471.      Example: FillStyle 0 1
  472.               FillStyle SolidFill Blue
  473.  
  474.  
  475.     Pattern  Pattern Name
  476.     -----------------------------------------------------------------
  477.        0     EmptyFill
  478.        1     SolidFill
  479.        2     LineFill
  480.        3     LtSlashFill
  481.        4     SlashFill
  482.        5     BkSlashFill
  483.        6     LtBkslashFill
  484.        7     HatchFill
  485.        8     XHatchFill
  486.        9     InterleaveFill
  487.       10     WidedotFill
  488.       11     CloseDotFill
  489.       12     CustomFill
  490.  
  491. ---------------------------------------------------------------------
  492. FillPattern
  493. ---------------------------------------------------------------------
  494.     Function: Sets user defined custom fill pattern and color
  495. Parameter(s): c1 c2 c3 c4 c5 c6 c7 c8 color
  496.  
  497.      Example: FillPattern 128 128 128 128 128 128 128 128 1
  498.               FillPattern 128 128 128 128 128 128 128 128 Blue
  499.  
  500.  
  501. ---------------------------------------------------------------------
  502. Mouse
  503. ---------------------------------------------------------------------
  504.     Function: Sets a rectangular hot mouse region
  505. Parameter(s): x y x2 y2 clk clr CommandText
  506.  
  507.      Example: Mouse 10 10 50 50 0 0 g^M
  508.               Mouse 10 10 +40 +40 0 0 g^M
  509.  
  510.  
  511. NOTE: Refer to RipScrip Specs for clk and clr flags  when using
  512.       Mouse function with BBS screens.
  513.  
  514.  
  515. ---------------------------------------------------------------------
  516. KillMouseFields
  517. ---------------------------------------------------------------------
  518.     Function: Erase all previously defined hot mouse regions from
  519.               memory
  520. Parameter(s): none
  521.  
  522.      Example: KillMouseFields
  523.  
  524.  
  525. ---------------------------------------------------------------------
  526. BeginText
  527. ---------------------------------------------------------------------
  528.     Function: Sets a rectangular text region
  529. Parameter(s): x y x2 y2
  530.  
  531.      Example: BeginText 100 100 400 300
  532.               BeginText 100 100 +300 +200
  533.  
  534.  
  535. ---------------------------------------------------------------------
  536. RegionText
  537. ---------------------------------------------------------------------
  538.     Function: Prints a line of text in the previously defined text
  539.               region and goes to the next line
  540. Parameter(s): Justify TextString
  541.  
  542.      Example: RegionText 0 Hello, this is an example of region text
  543.  
  544.  
  545. ---------------------------------------------------------------------
  546. EndText
  547. ---------------------------------------------------------------------
  548.     Function:  End a rectangular text region, no more RegionText
  549.                commands.
  550. Parameter(s): none
  551.  
  552.      Example: EndText
  553.  
  554. ---------------------------------------------------------------------
  555. GetImage
  556. ---------------------------------------------------------------------
  557.     Function: Copies a rectangular area (upto 64K) of the screen to
  558.               the clipboard.
  559. Parameter(s): x y x2 y2
  560.  
  561.      Example: GetImage 0 0 50 50
  562.               GetImage 0 0 +50 +50
  563.  
  564.  
  565. ---------------------------------------------------------------------
  566. PutImage
  567. ---------------------------------------------------------------------
  568.     Function: Copies the clipboard contents to an area on the screen
  569. Parameter(s): x y mode
  570.  
  571.      Example: PutImage 10 10 0
  572.               PutImage 10 10 CopyPut
  573.               PutImage 10 10 XorPut
  574.               PutImage 10 10 AndPut
  575.               PutImage 10 10 NotPut
  576.  
  577.  
  578. ---------------------------------------------------------------------
  579. WriteIcon
  580. ---------------------------------------------------------------------
  581.     Function: Saves the contents of the clipboard to disk
  582. Parameter(s): filename
  583.  
  584.      Example: WriteIcon image.icn
  585.  
  586.  
  587. ---------------------------------------------------------------------
  588. LoadIcon
  589. ---------------------------------------------------------------------
  590.     Function: Loads and displays an icon file
  591. Parameter(s): x y mode clipboard filename
  592.  
  593.      Example: LoadIcon 10 10 0 0 image.icn
  594.               LoadIcon 10 10 CopyPut 0 image.icn
  595.               LoadIcon 10 10 XorPut  1 image.icn
  596.  
  597. If the clipboard parameter is set to 1 then the image is pasted on the
  598. screen AND also copied onto the Clipboard.
  599.  
  600.  
  601. ---------------------------------------------------------------------
  602. ButtonStyle
  603. ---------------------------------------------------------------------
  604.     Function: Sets a new button style
  605. Parameter(s): none
  606.  
  607.      Example: ButtonStyle
  608.  
  609. You can change the button style fields using the button style command
  610. followed by a dot and the field name and value. The fields that contain
  611. the "#" must contain numeric values, those with "ON/OFF" must contain the
  612. word "ON" or "OFF"
  613.  
  614.   ButtonStyle.Width #                              (def= 80)
  615.   ButtonStyle.Height #                             (def= 30)
  616.   ButtonStyle.Orient #                             (def= 2)
  617.   ButtonStyle.BevSize #                            (def= 3)
  618.   ButtonStyle.DFore #                              (def= 2)
  619.   ButtonStyle.DBack #                              (def= 0)
  620.   ButtonStyle.Bright #                             (def= 15)
  621.   ButtonStyle.Dark #                               (def= 8)
  622.   ButtonStyle.Surface #                            (def= 7)
  623.   ButtonStyle.GroupNum #                           (def= 0)
  624.   ButtonStyle.UlineCol #                           (def= 4)
  625.   ButtonStyle.CornerCol #                          (def= 7)
  626.   ButtonStyle.IconButton ON/OFF                    (def= OFF)
  627.   ButtonStyle.PlainButton ON/OFF                   (def= ON)
  628.   ButtonStyle.ClipButton ON/OFF                    (def= OFF)
  629.   ButtonStyle.Mouse ON/OFF                         (def= OFF)
  630.   ButtonStyle.Invertable ON/OFF                    (def= OFF)
  631.   ButtonStyle.Reset ON/OFF                         (def= OFF)
  632.   ButtonStyle.Chisel ON/OFF                        (def= ON)
  633.   ButtonStyle.Recess ON/OFF                        (def= ON)
  634.   ButtonStyle.Shadow ON/OFF                        (def= ON)
  635.   ButtonStyle.Stamp ON/OFF                         (def= OFF)
  636.   ButtonStyle.Bevel ON/OFF                         (def= ON)
  637.   ButtonStyle.Underline ON/OFF                     (def= OFF)
  638.   ButtonStyle.HotIcon ON/OFF                       (def= OFF)
  639.   ButtonStyle.ADJ ON/OFF                           (def= OFF)
  640.   ButtonStyle.RadioGroup ON/OFF                    (def= OFF)
  641.   ButtonStyle.Sunken ON/OFF                        (def= ON)
  642.   ButtonStyle.CheckBoxGroup ON/OFF                 (def= OFF)
  643.   ButtonStyle.HighlightKey ON/OFF                  (def= OFF)
  644.   ButtonStyle.Explode ON/OFF                       (def= OFF)
  645.   ButtonStyle.LeftJustify ON/OFF                   (def= OFF)
  646.   ButtonStyle.RightJustify ON/OFF                  (def= OFF)
  647.   ButtonStyle.Selected ON/OFF                      (def= OFF)
  648.  
  649.   Width       - Buttons width size
  650.   Height      - Buttons height size
  651.   Orient      - Button label orientation 0=Above button
  652.                                          1=Left of Button
  653.                                          2=Center
  654.                                          3=Right of Button
  655.                                          4=Below button
  656.  
  657.   BevSize     - Buttons bevel size
  658.   DFore       - Text color for label
  659.   DBack       - Shadow color for label
  660.   Bright      - Left-Top color of the bevel
  661.   Dark        - Lower-Right color of the bevel
  662.   Surface     - Surface color of the button
  663.  
  664.   GroupNum    - For BBS use, see RIPScrip specs
  665.  
  666.   UlineCol    - Color used for Underline and marking Hotkeys
  667.   CornerCol   - Color used for button corners
  668.  
  669.   IconButton  - Makes button use an Icon for the background
  670.   PlainButton - Makes button plain, default setting
  671.   ClipButton  - Makes button use the contents of the clipboard as a
  672.                 background
  673.  
  674.   Mouse       - Makes button able to accept input with a mouse or hotkey
  675.   Invertable  - Inverts button when selected
  676.  
  677.   Reset       - Resets screen after button is selected
  678.   Chisel      - Give button a chisel look
  679.   Recess      - Give button a recess affect
  680.   Shadow      - Use Text shadow in button label
  681.   Stamp       - Copy button image to clipboard
  682.   Bevel       - Give button a bevel effect
  683.   Underline   - underline hotkey in button label
  684.  
  685.   HotIcon     - Use alternative icon when icon button is selected
  686.   ADJ         - Adjust button label to fit properly
  687.   RadioGroup  - For BBS use, See RIPScrip specs
  688.  
  689.   Sunken      - Give button a sunken effect
  690.   CheckBoxGroup - For BBS use, see RIPScrip Spec
  691.  
  692.   HighlightKey - Highlight hot key
  693.   Explode      - Give button an explode effect when selected
  694.  
  695.   LeftJustify  - Left justify button label
  696.   RightJustify - Right justify button label
  697.  
  698.   Selected     - Draw button already selected
  699.  
  700.  
  701. For more information on what these flags do please refer to the
  702. RipScrip protocol specifications.
  703.  
  704. ---------------------------------------------------------------------
  705. Button
  706. ---------------------------------------------------------------------
  707.     Function: Defines a Button
  708. Parameter(s): x y x2 y2 hotkey commandtext
  709.  
  710.      Example: Button 10 10 0 0 g <>GoodBye<>g^M
  711.               Button 10 10 0 0 #103 <>GoodBye<>g^M
  712.               Button 10 10 +40 +40 g <>GoodBye<>g^M
  713.               Button 10 10 0 0 g image.icn<>GoodBye<>g^M
  714.  
  715. This command requires that you issue a button style command before it
  716. can be used. The x2 and y2 parameters can be left to zero if you wish
  717. to use the size specified in the Button Style fields.
  718.  
  719. For the hotkey you can use the actual letter or use the ascii
  720. value by placing the pound sign in front of the number.
  721.  
  722.  
  723. NOTE: The command text field actually contains three fields separated
  724.       by <> characters. The first field contains the filename of an
  725.       icon if the button is an icon button otherwise its left out.
  726.       The second field begins after the <> separator, its the label
  727.       for the button. The last field separated by another <> is the
  728.       host command, it is what will be sent to the host when that
  729.       button is pressed.
  730.  
  731.       When creating BBS screens the host command is simply a piece of
  732.       text that tells the BBS what function to perform.
  733.  
  734.       When creating JMedia applications the host command can contain
  735.       filenames and additional commands that can be executed. Refer to
  736.       JMedia demos for usage.
  737.  
  738. ---------------------------------------------------------------------
  739. Define
  740. ---------------------------------------------------------------------
  741.     Function: Define a text variable
  742. Parameter(s): flag TextString
  743.  
  744.      Example: Define 1 text_var,60:?question?default data
  745.  
  746. Refer to RipScrip Specs for additional information
  747.  
  748. NOTE: This command is also used to store extended commands when
  749.       creating JMedia applications.
  750.  
  751.  
  752.  
  753. ---------------------------------------------------------------------
  754. Query
  755. ---------------------------------------------------------------------
  756.     Function: Query the contents of a text variable
  757. Parameter(s): mode TextString
  758.  
  759.      Example: Query 0 this is a query $COMMAND$^m
  760.  
  761. Refer to RipScrip specs for additional information
  762.  
  763.  
  764.  
  765. ---------------------------------------------------------------------
  766. CopyRegion
  767. ---------------------------------------------------------------------
  768.     Function: Copy screen portion up or down
  769. Parameter(s): x y x2 y2 destline
  770.  
  771.      Example: CopyRegion 0 0 639 39 60
  772.  
  773. NOTE: x and x2 parameters must be evenly divisible by 8.
  774.  
  775.  
  776. ---------------------------------------------------------------------
  777. ReadScene
  778. ---------------------------------------------------------------------
  779.     Function: Display a local RIP file
  780. Parameter(s): filename
  781.  
  782.      Example: ReadScene file.RIP
  783.  
  784.  
  785. ---------------------------------------------------------------------
  786. FileQuery
  787. ---------------------------------------------------------------------
  788.     Function: Query existing information on a particular file
  789. Parameter(s): mode filename
  790.  
  791.      Example: FileQuery 0 TEST.RIP
  792.  
  793. Refer RipScrip specs for additional information
  794.  
  795.  
  796. ---------------------------------------------------------------------
  797. EnterBlockMode
  798. ---------------------------------------------------------------------
  799.     Function: Enter block transfer mode with host
  800. Parameter(s): mode protocol filetype filename
  801.  
  802.      Example: EnterBlockMode 1 7 MENU.RIP
  803.  
  804. Refer RipScrip specs for additional information
  805.  
  806.  
  807. ---------------------------------------------------------------------
  808. Wizard                                                (MACRO COMMAND)
  809. ---------------------------------------------------------------------
  810.     Function: Inserts a wizard object
  811. Parameter(s): x y x2 y2 filename
  812.  
  813.      Example: Wizard 10 10 100 100 METWIN.WIZ
  814.               Wizard 10 10 +90 +90 METWIN.WIZ
  815.  
  816.  There are a number of wizard file that you can use wich contain
  817.  the WIZ extension. You can even create your own wizard files.
  818.  
  819.  A Wizard file is a text containing simple one letter commands.
  820.  
  821.          c color         - Sets the draw color
  822.          S style color   - Sets the Fill Style and Fill Color
  823.          X x y           - Plots a pixel in the current draw color
  824.          F x y border    - Paints an enclosed area at x,y stopping
  825.                            only when it encounters a pixel indicated
  826.                            by border
  827.          L x y x2 y2     - Draw a line from x,y to x2,y2
  828.          R x y x2 y2     - Draw a rectangle from x,y to x2,y2
  829.          B x y x2 y2     - Draw a filled rectangle from x,y to x2,y2
  830.          o x y r1 r2     - Draw an ellipse at x,y with a radius of r1,r2
  831.          O x y r1 r2     - Draw a filled ellipse at x,y with a radius of r1,r2
  832.          Z x y x2 y2 x3 y3 x4 y4 segments - Draw a bezier curve
  833.  
  834.       When the variables x,y,x2,y2 are used with the command they will be
  835.       substituted for the values entered with Wizard command at run time.
  836.       The variable cx and cy represent the center position of the area
  837.       specified.
  838.  
  839.       Study the sample WIZ files to get a better understanding on how to
  840.       create your own WIZ files.
  841.  
  842.  
  843. ---------------------------------------------------------------------
  844. InsertIco                                             (MACRO COMMAND)
  845. ---------------------------------------------------------------------
  846.     Function: Inserts a Windows Ico file
  847. Parameter(s): x y filename
  848.  
  849.      Example: InsertIco 10 10 COMM.ICO
  850.  
  851.  
  852. ---------------------------------------------------------------------
  853. End                                                (EXTENDED COMMAND)
  854. ---------------------------------------------------------------------
  855.     Function: Ends the current application and returns to text mode
  856. Parameter(s): none
  857.  
  858.      Example: End
  859.  
  860.  
  861.  
  862. ---------------------------------------------------------------------
  863. TextColor                                          (EXTENDED COMMAND)
  864. ---------------------------------------------------------------------
  865.     Function: Sets the text windows foreground color
  866. Parameter(s): Color
  867.  
  868.      Example: TextColor 2
  869.               TextColor Green
  870.  
  871. ---------------------------------------------------------------------
  872. TextBackGround                                     (EXTENDED COMMAND)
  873. ---------------------------------------------------------------------
  874.     Function: Sets the text windows background color
  875. Parameter(s): Color
  876.  
  877.      Example: TextBackGround 1
  878.               TextBackGround Blue
  879.  
  880. The background color can only have values ranging from 0 to 7
  881.  
  882.  
  883. ---------------------------------------------------------------------
  884. BTextColor                                         (EXTENDED COMMAND)
  885. ---------------------------------------------------------------------
  886.     Function: Sets the foreground color for picklist hilight bar
  887. Parameter(s): Color
  888.  
  889.      Example: BTextColor 2
  890.               BTextColor Green
  891.  
  892.  
  893. ---------------------------------------------------------------------
  894. BTextBackGround                                    (EXTENDED COMMAND)
  895. ---------------------------------------------------------------------
  896.     Function: Sets the background color for the picklist hilight bar
  897. Parameter(s): Color
  898.  
  899.      Example: BTextBackGround 1
  900.               BTextBackGround Blue
  901.  
  902. ---------------------------------------------------------------------
  903. AddHotKey                                          (EXTENDED COMMAND)
  904. ---------------------------------------------------------------------
  905.     Function: Adds a hot key
  906. Parameter(s): Key CommandString
  907.  
  908.      Example: AddHotKey e EXIT^M
  909.               AddHotKey #32 EXIT^M
  910.               AddHotKey ^A EXIT^M
  911.  
  912.  The key parameter can entered in ascii code format by adding a pound
  913.  sign in front of the number. Control codes can also be entered by adding
  914.  a caret in front of the letter. Control codes can only range from
  915.  A to Z.
  916.  
  917. ---------------------------------------------------------------------
  918. ReMapKey                                           (EXTENDED COMMAND)
  919. ---------------------------------------------------------------------
  920.     Function: Remaps a hot key with another hot key
  921. Parameter(s): OldKey NewKey
  922.  
  923.      Example: ReMapKey e d
  924.               ReMapKey #32 #65
  925.               ReMapKey ^A ^B
  926.               ReMapKey ^A #66
  927.               ReMapKey ^A B
  928.  
  929.  The key parameter can entered in ascii code format by adding a pound
  930.  sign in front of the number. Control codes can also be entered by adding
  931.  a caret in front of the letter. Control codes can only range from
  932.  A to Z.
  933.  
  934. The RemapKey function can also be used to overwrite the default keys
  935. for selecting buttons using the keyboard.
  936.  
  937. The Tab key can be reassigned using      : ReMapKey NEXT NewKey
  938. The Shift-Tab key can be reassigned using: ReMapKey PREVIOUS NewKey
  939. The Enter key can be reassigned using    : ReMapKey ENTER NewKey
  940. The Esc key can be reassigned using      : ReMapKey ABORT NewKey
  941.  
  942. The NewKey must be in entered using the pound sign and using an extended
  943. ascii code. These codes are listed in ASCII.TXT or simply use the
  944. CODE.EXE program.
  945.  
  946.  
  947. ---------------------------------------------------------------------
  948. Delay                                              (EXTENDED COMMAND)
  949. ---------------------------------------------------------------------
  950.     Function: Delays a specified number of milliseconds
  951. Parameter(s): milliseconds
  952.  
  953.      Example: Delay 2000
  954.  
  955. 1000 milliseconds equals roughly 1 second
  956.  
  957.  
  958. ---------------------------------------------------------------------
  959. CommandDelay                                       (EXTENDED COMMAND)
  960. ---------------------------------------------------------------------
  961.     Function: Sets the delay period to be executed after each command
  962. Parameter(s): milliseconds
  963.  
  964.      Example: CommandDelay 50
  965.  
  966.  
  967. ---------------------------------------------------------------------
  968. ExecuteList                                        (EXTENDED COMMAND)
  969. ---------------------------------------------------------------------
  970.     Function: Executes a text file which contains series of extended
  971.               commands
  972. Parameter(s): filename
  973.  
  974.      Example: ExecuteList CMD.TXT
  975.  
  976.  
  977. ---------------------------------------------------------------------
  978. Push                                               (EXTENDED COMMAND)
  979. ---------------------------------------------------------------------
  980.     Function: Pushes a command into JMedia's command stack, last in
  981.               first out (LIFO). The ^M is used as a command
  982.               separator and terminator
  983. Parameter(s): command
  984.  
  985.      Example: Push PLAY abc^M
  986.  
  987. ---------------------------------------------------------------------
  988. Pop                                                (EXTENDED COMMAND)
  989. ---------------------------------------------------------------------
  990.     Function: Removes the last command from JMedia's command stack
  991. Parameter(s): none
  992.  
  993.      Example: Pop
  994.  
  995.  
  996. ---------------------------------------------------------------------
  997. ClearStack                                         (EXTENDED COMMAND)
  998. ---------------------------------------------------------------------
  999.     Function: Erases all the commands from JMedia's command stack
  1000. Parameter(s): none
  1001.  
  1002.      Example: ClearStack
  1003.  
  1004.  
  1005. ---------------------------------------------------------------------
  1006. Sound                                              (EXTENDED COMMAND)
  1007. ---------------------------------------------------------------------
  1008.     Function: Starts generating a sound at specified frequency
  1009. Parameter(s): frequency
  1010.  
  1011.      Example: Sound 400
  1012.  
  1013.  
  1014. ---------------------------------------------------------------------
  1015. NoSound                                            (EXTENDED COMMAND)
  1016. ---------------------------------------------------------------------
  1017.     Function: Shuts the sound off
  1018. Parameter(s): none
  1019.  
  1020.      Example: NoSound
  1021.  
  1022.  
  1023. ---------------------------------------------------------------------
  1024. NoSound                                            (EXTENDED COMMAND)
  1025. ---------------------------------------------------------------------
  1026.     Function: Shuts the sound off
  1027. Parameter(s): none
  1028.  
  1029.      Example: NoSound
  1030.  
  1031.  
  1032. ---------------------------------------------------------------------
  1033. Play                                               (EXTENDED COMMAND)
  1034. ---------------------------------------------------------------------
  1035.     Function: Plays a series of musical notes. Uses the same format
  1036.               as QBasic's PLAY command.
  1037. Parameter(s): notes
  1038.  
  1039.      Example: Play abc
  1040.  
  1041.  
  1042. ---------------------------------------------------------------------
  1043. Screen                                             (EXTENDED COMMAND)
  1044. ---------------------------------------------------------------------
  1045.     Function: Selects a new screen mode
  1046. Parameter(s): mode
  1047.  
  1048.      Example: Screen 1
  1049.  
  1050.   There are 14 screen modes to choose from, depending on your display
  1051.   card some of these modes might not be available. It is important to
  1052.   try and determine which modes your display card can support before
  1053.   using them in a JMedia application. If your display card cannot
  1054.   display a certain mode it can cause JMedia to crash.
  1055.  
  1056.    Mode  Resolution
  1057.    -------------------
  1058.     0    640x200x16
  1059.     1    640x350x16
  1060.     2    640x480x16
  1061.     3    320x200x16
  1062.     4    640x200x16
  1063.     5    640x350x16
  1064.     6    640x480x16
  1065.     7    800x600x16
  1066.     8    1024x768x16
  1067.     9    320x200x256
  1068.    10    640x400x256
  1069.    11    640x480x256
  1070.    12    800x600x256
  1071.    13    1024x768x256
  1072.  
  1073.  
  1074. ---------------------------------------------------------------------
  1075. RestoreCrtMode                                     (EXTENDED COMMAND)
  1076. ---------------------------------------------------------------------
  1077.     Function: Returns to Text Mode
  1078. Parameter(s): none
  1079.  
  1080.      Example: RestoreCrtMode
  1081.  
  1082.  
  1083. ---------------------------------------------------------------------
  1084. Execute                                            (EXTENDED COMMAND)
  1085. ---------------------------------------------------------------------
  1086.     Function: Executes an external file or shells to DOS
  1087. Parameter(s): none or filename
  1088.  
  1089.      Example: Execute
  1090.               Execute GAME.EXE
  1091.  
  1092.  
  1093. ---------------------------------------------------------------------
  1094. StuffString                                        (EXTENDED COMMAND)
  1095. ---------------------------------------------------------------------
  1096.     Function: Stuffs the keyboard buffer with characters
  1097. Parameter(s): characters
  1098.  
  1099.      Example: StuffString hello
  1100.  
  1101.  
  1102. ---------------------------------------------------------------------
  1103. ClearKbdBuffer                                     (EXTENDED COMMAND)
  1104. ---------------------------------------------------------------------
  1105.     Function: Clears the keyboard buffer
  1106. Parameter(s): none
  1107.  
  1108.      Example: ClearKbdBuffer
  1109.  
  1110.  
  1111. ---------------------------------------------------------------------
  1112. KbdToStack                                         (EXTENDED COMMAND)
  1113. ---------------------------------------------------------------------
  1114.     Function: Copies the keyboard buffer contents to JMedia's
  1115.               command stack
  1116. Parameter(s): none
  1117.  
  1118.      Example: KbdToStack
  1119.  
  1120.  
  1121. ---------------------------------------------------------------------
  1122. MBRelease                                          (EXTENDED COMMAND)
  1123. ---------------------------------------------------------------------
  1124.     Function: Sets an internal flag that informs JMedia how to handle
  1125.               button commands when pressed. When set to "ON" JMedia
  1126.               will wait for the mouse button to be released before
  1127.               continuing.
  1128. Parameter(s): ON/OFF
  1129.  
  1130.      Example: MBRelease ON
  1131.               MBRelease OFF
  1132.  
  1133. ---------------------------------------------------------------------
  1134. CharCase                                           (EXTENDED COMMAND)
  1135. ---------------------------------------------------------------------
  1136.     Function: Sets an internal flag that informs JMedia how to handle
  1137.               hot keys. If CharCase is set to "ON" than the key pressed
  1138.               must be exactly the same, in other words case sensitive.
  1139. Parameter(s): ON/OFF
  1140.  
  1141.      Example: CharCase ON
  1142.               CharCase OFF
  1143.  
  1144.  
  1145. ---------------------------------------------------------------------
  1146. Cursor                                             (EXTENDED COMMAND)
  1147. ---------------------------------------------------------------------
  1148.     Function: Toggles the cursor in the Text Window ON or OFF
  1149. Parameter(s): ON/OFF
  1150.  
  1151.      Example: Cursor ON
  1152.               Cursor OFF
  1153.  
  1154.  
  1155. ---------------------------------------------------------------------
  1156. Ansi                                               (EXTENDED COMMAND)
  1157. ---------------------------------------------------------------------
  1158.     Function: Sets the ansi flag to ON or OFF. This command must be
  1159.               used before a TextWindow command.
  1160. Parameter(s): ON/OFF
  1161.  
  1162.      Example: Ansi ON
  1163.               Ansi OFF
  1164.  
  1165.  
  1166. ---------------------------------------------------------------------
  1167. MouseState                                         (EXTENDED COMMAND)
  1168. ---------------------------------------------------------------------
  1169.     Function: This command tells JMedia to enable/disable mouse input.
  1170.               This command has no effect if a Mouse is not detected.
  1171. Parameter(s): ON/OFF
  1172.  
  1173.      Example: MouseState ON
  1174.               MouseState OFF
  1175.  
  1176. ---------------------------------------------------------------------
  1177. InvertArea                                         (EXTENDED COMMAND)
  1178. ---------------------------------------------------------------------
  1179.     Function: Inverts a rectangular area on the screen
  1180. Parameter(s): x y x2 y2 XorColor
  1181.  
  1182.      Example: InvertArea 10 10 100 100 15
  1183.               InvertArea 10 10 +90 +90 White
  1184.  
  1185.  
  1186. ---------------------------------------------------------------------
  1187. ShowPcx                                            (EXTENDED COMMAND)
  1188. ---------------------------------------------------------------------
  1189.     Function: Displays a PCX image
  1190. Parameter(s): x y name pal
  1191.  
  1192.      Example: ShowPcx 10 10 image.pcx YES
  1193.               ShowPcx 10 10 image.pcx NO
  1194.  
  1195. ---------------------------------------------------------------------
  1196. ShowPcxFile                                        (EXTENDED COMMAND)
  1197. ---------------------------------------------------------------------
  1198.     Function: Displays an external PCX file image
  1199. Parameter(s): x y name pal
  1200.  
  1201.      Example: ShowPcx 10 10 image.pcx YES
  1202.               ShowPcx 10 10 image.pcx NO
  1203.  
  1204.  
  1205. NOTE: When using this command from JMedia's IDE it behaves the same way
  1206.       as the ShowPcx function. The difference is when you create an
  1207.       executable file using these two commands. The ShowPcx function
  1208.       will search the executable for the PCX image but the ShowPcxFile
  1209.       will search for a PCX file.
  1210.  
  1211.  
  1212.  
  1213. ---------------------------------------------------------------------
  1214. Browse                                             (EXTENDED COMMAND)
  1215. ---------------------------------------------------------------------
  1216.     Function: Displays a text file using Browser sub-commands
  1217. Parameter(s): filename
  1218.  
  1219.      Example: Browse README.TXT
  1220.  
  1221. This function cannot work by itself, additional setup steps must be
  1222. taken.
  1223.  
  1224.  
  1225. 1) A text window must be defined. This creates the area and selects
  1226.    the font the browser will use to display the text file contents.
  1227.    See TextWindow function.
  1228.  
  1229. 2) Button commands/hot keys must issued containing browser sub-commands.
  1230.    These sub-commands tell the browser to do simple things such as page
  1231.    up/down, home/end, and other functions you would normally find in a
  1232.    text file browser. You can use all the browser sub-commands or as
  1233.    many as you want.  This allows you to truly create custom looking
  1234.    applications.  See Button function.
  1235.  
  1236. 3) You can use the TextColor and TextBackGround functions to select the
  1237.    text colors the browser will be using.
  1238.  
  1239.  
  1240. Available browser sub-commands  are CASE sensitive, they must be entered
  1241. exactly as listed.
  1242.  
  1243.   PGUP
  1244.   PGDOWN
  1245.   HOME
  1246.   END
  1247.   MOVEUP
  1248.   MOVEDOWN
  1249.   GOTOLINE
  1250.   SAVEPOS
  1251.   RESTOREPOS
  1252.   EXIT
  1253.  
  1254.  
  1255. ---------------------------------------------------------------------
  1256. PickList                                           (EXTENDED COMMAND)
  1257. ---------------------------------------------------------------------
  1258.     Function: Displays a picklist file using picklist sub-commands
  1259. Parameter(s): filename
  1260.  
  1261.      Example: PickList CMD.TXT
  1262.  
  1263. You must set up the picklist command the way you set up the browser
  1264. command. There are two additional commands required for the picklist,
  1265. the BTextColor and BTextBackGround. These set the colors for the select
  1266. bar.
  1267.  
  1268. A picklist file is simply a file containing a series of item
  1269. descriptions followed by a command to issue once that item has been
  1270. selected. Item descriptions and commands are separated using <>
  1271. characters. A sample picklist file might look like this:
  1272.  
  1273. Introduction   <>intro.rip^M
  1274. Installation   <>instal.rip^M
  1275. Requirements   <>req.rip^M
  1276.  
  1277. Available picklist sub-commands are CASE sensitive,  they must be entered
  1278. exactly as listed. You must assign one button or hot key with the accept
  1279. command, this will add the item command to JMedia's stack and exit the
  1280. picklist object.
  1281.  
  1282.   ACCEPT
  1283.   SCROLLUP
  1284.   SCROLLDOWN
  1285.   PGUP
  1286.   PGDOWN
  1287.   HOME
  1288.   END
  1289.   MOVEUP
  1290.   MOVEDOWN
  1291.   GOTOLINE
  1292.   SAVEPOS
  1293.   RESTOREPOS
  1294.   EXIT
  1295.  
  1296.